<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<title>MMTFolder</title>
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
    if (location.href.indexOf('is-external=true') == -1) {
        parent.document.title="MMTFolder";
    }
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!--   -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!--   -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../index-all.html">Index</a></li>
<li><a href="../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../mmj/tl/MMTFileFilter.html" title="class in mmj.tl"><span class="strong">Prev Class</span></a></li>
<li><a href="../../mmj/tl/MMTTheoremExportFormatter.html" title="class in mmj.tl"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?mmj/tl/MMTFolder.html" target="_top">Frames</a></li>
<li><a href="MMTFolder.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_top");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!--   -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">mmj.tl</div>
<h2 title="Class MMTFolder" class="title">Class MMTFolder</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>mmj.tl.MMTFolder</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="strong">MMTFolder</span>
extends java.lang.Object</pre>
<div class="block">MMTFolder is a helper class for the Theorem Loader.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!--   -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../mmj/tl/MMTFolder.html#MMTFolder()">MMTFolder</a></strong>()</code>
<div class="block">Default constructor for MMTFolder.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../mmj/tl/MMTFolder.html#MMTFolder(java.io.File)">MMTFolder</a></strong>(java.io.File&nbsp;file)</code>
<div class="block">Constructor for MMTFolder using File object.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../mmj/tl/MMTFolder.html#MMTFolder(java.io.File, java.lang.String)">MMTFolder</a></strong>(java.io.File&nbsp;filePath,
         java.lang.String&nbsp;mmtFolderName)</code>
<div class="block">Constructor for MMTFolder using pathname String.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!--   -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../mmj/tl/MMTTheoremSet.html" title="class in mmj.tl">MMTTheoremSet</a></code></td>
<td class="colLast"><code><strong><a href="../../mmj/tl/MMTFolder.html#constructMMTTheoremSet(mmj.lang.LogicalSystem, mmj.lang.Messages, mmj.tl.TlPreferences)">constructMMTTheoremSet</a></strong>(<a href="../../mmj/lang/LogicalSystem.html" title="class in mmj.lang">LogicalSystem</a>&nbsp;logicalSystem,
                      <a href="../../mmj/lang/Messages.html" title="class in mmj.lang">Messages</a>&nbsp;messages,
                      <a href="../../mmj/tl/TlPreferences.html" title="class in mmj.tl">TlPreferences</a>&nbsp;tlPreferences)</code>
<div class="block">Builds the MMTTheoremSet object for an MMTFolder using all the files in
 the folder with file type ".mmt".</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../mmj/tl/MMTTheoremSet.html" title="class in mmj.tl">MMTTheoremSet</a></code></td>
<td class="colLast"><code><strong><a href="../../mmj/tl/MMTFolder.html#constructMMTTheoremSet(java.lang.String, mmj.lang.LogicalSystem, mmj.lang.Messages, mmj.tl.TlPreferences)">constructMMTTheoremSet</a></strong>(java.lang.String&nbsp;theoremLabel,
                      <a href="../../mmj/lang/LogicalSystem.html" title="class in mmj.lang">LogicalSystem</a>&nbsp;logicalSystem,
                      <a href="../../mmj/lang/Messages.html" title="class in mmj.lang">Messages</a>&nbsp;messages,
                      <a href="../../mmj/tl/TlPreferences.html" title="class in mmj.tl">TlPreferences</a>&nbsp;tlPreferences)</code>
<div class="block">Builds an MMTTheoremSet object for a single theorem in a file in the
 MMTFolder.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../mmj/tl/MMTFolder.html#getAbsolutePath()">getAbsolutePath</a></strong>()</code>
<div class="block">Returns the absolute pathname of the MMTFolder.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.io.File</code></td>
<td class="colLast"><code><strong><a href="../../mmj/tl/MMTFolder.html#getFolderFile()">getFolderFile</a></strong>()</code>
<div class="block">Returns the File object for the MMTFolder.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../mmj/tl/MMTTheoremFile.html" title="class in mmj.tl">MMTTheoremFile</a></code></td>
<td class="colLast"><code><strong><a href="../../mmj/tl/MMTFolder.html#storeMMTTheoremFile(java.lang.String, java.util.List)">storeMMTTheoremFile</a></strong>(java.lang.String&nbsp;theoremLabel,
                   java.util.List&lt;java.lang.StringBuilder&gt;&nbsp;mmtTheoremLines)</code>
<div class="block">Stores a theorem in the MMTFolder as a MMT Theorem file.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!--   -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!--   -->
</a>
<h3>Constructor Detail</h3>
<a name="MMTFolder()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>MMTFolder</h4>
<pre>public&nbsp;MMTFolder()</pre>
<div class="block">Default constructor for MMTFolder.</div>
</li>
</ul>
<a name="MMTFolder(java.io.File, java.lang.String)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>MMTFolder</h4>
<pre>public&nbsp;MMTFolder(java.io.File&nbsp;filePath,
         java.lang.String&nbsp;mmtFolderName)
          throws <a href="../../mmj/lang/TheoremLoaderException.html" title="class in mmj.lang">TheoremLoaderException</a></pre>
<div class="block">Constructor for MMTFolder using pathname String.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>filePath</code> - path for mmtFolderName. May be null or absolute or
            relative path name.</dd><dd><code>mmtFolderName</code> - String containing absolute or relative pathname.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../mmj/lang/TheoremLoaderException.html" title="class in mmj.lang">TheoremLoaderException</a></code> - if mmtFolderName is null, is blank,
             doesn't exist, is not a directory, or if there is a
             SecurityException.</dd></dl>
</li>
</ul>
<a name="MMTFolder(java.io.File)">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>MMTFolder</h4>
<pre>public&nbsp;MMTFolder(java.io.File&nbsp;file)
          throws <a href="../../mmj/lang/TheoremLoaderException.html" title="class in mmj.lang">TheoremLoaderException</a></pre>
<div class="block">Constructor for MMTFolder using File object.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>file</code> - File object.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../mmj/lang/TheoremLoaderException.html" title="class in mmj.lang">TheoremLoaderException</a></code> - if input file is null, doesn't exist, is
             not a directory, or if there is a SecurityException.</dd></dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!--   -->
</a>
<h3>Method Detail</h3>
<a name="getFolderFile()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFolderFile</h4>
<pre>public&nbsp;java.io.File&nbsp;getFolderFile()</pre>
<div class="block">Returns the File object for the MMTFolder.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>File object for the MMTFolder.</dd></dl>
</li>
</ul>
<a name="constructMMTTheoremSet(mmj.lang.LogicalSystem, mmj.lang.Messages, mmj.tl.TlPreferences)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>constructMMTTheoremSet</h4>
<pre>public&nbsp;<a href="../../mmj/tl/MMTTheoremSet.html" title="class in mmj.tl">MMTTheoremSet</a>&nbsp;constructMMTTheoremSet(<a href="../../mmj/lang/LogicalSystem.html" title="class in mmj.lang">LogicalSystem</a>&nbsp;logicalSystem,
                                   <a href="../../mmj/lang/Messages.html" title="class in mmj.lang">Messages</a>&nbsp;messages,
                                   <a href="../../mmj/tl/TlPreferences.html" title="class in mmj.tl">TlPreferences</a>&nbsp;tlPreferences)
                                     throws <a href="../../mmj/lang/TheoremLoaderException.html" title="class in mmj.lang">TheoremLoaderException</a></pre>
<div class="block">Builds the MMTTheoremSet object for an MMTFolder using all the files in
 the folder with file type ".mmt".</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>logicalSystem</code> - LogicalSystem object.</dd><dd><code>messages</code> - Messages object.</dd><dd><code>tlPreferences</code> - TlPreferences object.</dd>
<dt><span class="strong">Returns:</span></dt><dd>MMTTheoremSet the MMTTheoremSet object loaded with the
         MMTFolder's data.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../mmj/lang/TheoremLoaderException.html" title="class in mmj.lang">TheoremLoaderException</a></code> - if the MMTFolder File object is null or if
             there is an I/O error reading the directory.</dd></dl>
</li>
</ul>
<a name="constructMMTTheoremSet(java.lang.String, mmj.lang.LogicalSystem, mmj.lang.Messages, mmj.tl.TlPreferences)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>constructMMTTheoremSet</h4>
<pre>public&nbsp;<a href="../../mmj/tl/MMTTheoremSet.html" title="class in mmj.tl">MMTTheoremSet</a>&nbsp;constructMMTTheoremSet(java.lang.String&nbsp;theoremLabel,
                                   <a href="../../mmj/lang/LogicalSystem.html" title="class in mmj.lang">LogicalSystem</a>&nbsp;logicalSystem,
                                   <a href="../../mmj/lang/Messages.html" title="class in mmj.lang">Messages</a>&nbsp;messages,
                                   <a href="../../mmj/tl/TlPreferences.html" title="class in mmj.tl">TlPreferences</a>&nbsp;tlPreferences)
                                     throws <a href="../../mmj/lang/TheoremLoaderException.html" title="class in mmj.lang">TheoremLoaderException</a></pre>
<div class="block">Builds an MMTTheoremSet object for a single theorem in a file in the
 MMTFolder.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>theoremLabel</code> - Metamath label of the theorem to load into the
            MMTTheoremSet.</dd><dd><code>logicalSystem</code> - LogicalSystem object.</dd><dd><code>messages</code> - Messages object.</dd><dd><code>tlPreferences</code> - TlPreferences object.</dd>
<dt><span class="strong">Returns:</span></dt><dd>MMTTheoremSet an MMTTheoremSet object loaded with the MMTFolder's
         data for the requested theorem.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../mmj/lang/TheoremLoaderException.html" title="class in mmj.lang">TheoremLoaderException</a></code> - if the MMTFolder File object is null or if
             the theorem label is null or an empty string, or if the given
             theorem is not a valid MMT Theorem file in the directory
             (i.e. not found), or if there is a security exception.</dd></dl>
</li>
</ul>
<a name="storeMMTTheoremFile(java.lang.String, java.util.List)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>storeMMTTheoremFile</h4>
<pre>public&nbsp;<a href="../../mmj/tl/MMTTheoremFile.html" title="class in mmj.tl">MMTTheoremFile</a>&nbsp;storeMMTTheoremFile(java.lang.String&nbsp;theoremLabel,
                                 java.util.List&lt;java.lang.StringBuilder&gt;&nbsp;mmtTheoremLines)
                                   throws <a href="../../mmj/lang/TheoremLoaderException.html" title="class in mmj.lang">TheoremLoaderException</a></pre>
<div class="block">Stores a theorem in the MMTFolder as a MMT Theorem file.
 <p>
 Note: the input mmtTheoremLines List does not contain newline characters.
 Those are created by the program in a platform neutral manner.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>theoremLabel</code> - Metamath label of the theorem to store into the
            MMTTheoremSet.</dd><dd><code>mmtTheoremLines</code> - List of StringBuilder objects with one line (no
            newline!) per StringBuilder object, already formatted into
            Metamath .mm format.</dd>
<dt><span class="strong">Returns:</span></dt><dd>MMTTheoremFile the output MMTTheoremFile object as created during
         the store operation.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../mmj/lang/TheoremLoaderException.html" title="class in mmj.lang">TheoremLoaderException</a></code> - if the MMTFolder File object is null or if
             the theorem label is null or an empty string, or if there is
             an I/O error during the attempt to create an MMTTheoremFile.</dd></dl>
</li>
</ul>
<a name="getAbsolutePath()">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getAbsolutePath</h4>
<pre>public&nbsp;java.lang.String&nbsp;getAbsolutePath()</pre>
<div class="block">Returns the absolute pathname of the MMTFolder.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>Absolute pathname of the MMTFolder or null if the underlying File
         is null.TheoremFile.</dd></dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!--   -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!--   -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../index-all.html">Index</a></li>
<li><a href="../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../mmj/tl/MMTFileFilter.html" title="class in mmj.tl"><span class="strong">Prev Class</span></a></li>
<li><a href="../../mmj/tl/MMTTheoremExportFormatter.html" title="class in mmj.tl"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?mmj/tl/MMTFolder.html" target="_top">Frames</a></li>
<li><a href="MMTFolder.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_bottom");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!--   -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>
